home *** CD-ROM | disk | FTP | other *** search
/ Mac Mania 4 / MacMania 4.toast / / Internet software / BirthdayGrabber 1.0 / Read Me Please - Thanks! < prev   
Text File  |  1996-01-15  |  6KB  |  124 lines

  1.               BirthdayGrabber 1.0
  2.                                   A Userlog Birthday Analyzer for Second Sight....
  3.  
  4. Foreword:
  5.  
  6. I urge Sysops to print this file out as a reference for when they set up UserGrabber.  The data file (discussed below) has a lot of variables that need to be setup for proper operation of this application and its handy to have a "scratch copy" of this "Read Me" on hand to make notes.  I have used a text data file because its a lot faster and easier to manage once it is set up.  The overhead of a larger application taking more memory to have a built in setup dialog interface for variables that only need to be setup once didn't seem like a good idea to me.  When upgrading from previous versions of BirthdayGrabber, always read and print this file because some of the data fields change from time to time as I continue to improve this application.  You can also read further in the documentation under the title of "Upgrading" for a quick reference of what you need to do to upgrade from the previous version of the application.  Finally, BirthdayGrabber is fast  a typical Second Sight 3.5 Userlog with 400 users takes only 3 seconds to process on my Power Macintosh.  Please read the System Requirements at the end of this document.
  7.  
  8. What is it?:
  9.  
  10. BirthdayGrabber is an application for Second Sight that analyzes your Userlog during a netmail or a nightly external launch of Second Sight and creates a nicely formatted birthday report that you can use as a SYSTEMx.MSG or a readable text file for you and your users to enjoy with optional ANSI color output (see the below example for what the output looks like).
  11.  
  12. Why Use It?:
  13.  
  14. Its fun, fun, FUN!  I've seen these birthday lists on other systems and thought Second Sight could use one.  With the creation of Second Sight 3.5, its Userlog now contains data of user's birthday dates.  Included with this application is a survey file that will let your users enter their birth dates at login.  Read the "About the Survey" file (contained in this archive) for more information.
  15.  
  16. What The Output File Looks Like:
  17.  
  18.  
  19.  
  20.  
  21.  
  22.  
  23.  
  24.  
  25.  
  26.  
  27.  
  28.  
  29.  
  30.  
  31.  
  32.  
  33. Above you can see the result of launching BirthdayGrabber.   A nice ANSI output is presented (for those users who can support it) and for those who cannot, Second Sight’s excellent ANSI filter will remove the colors and the boarders for you.
  34.  
  35. How To Set It Up:
  36.  
  37. 1. Place BirthdayGrabber and the BirthdayGrabberData file in the same folder as your Second Sight application, they must be in the same folder as the BBS program to operate correctly.
  38.  
  39. 2. Using a text processor (SimpleText, RedWriter) open the UserGrabberData file, you will see something that looks like this:
  40.  
  41. 255
  42. Macintosh HD1:SSBBS:UserLog
  43. Macintosh HD1:SSBBS:Special Msgs:Bdays!
  44. Macintosh HD1:SSBBS:Gliders
  45. [0;1;34;47mThe Final Nexus [0;30;47m
  46. 6
  47. 1
  48. 5
  49. 2
  50. 8
  51. 1
  52. 0
  53.  
  54. This file contains the variables and data that UserGrabber needs to operate, listed below are what each variable is; customize it to suit your needs.
  55.  
  56. Macintosh HD1:SSBBS:Userlog                     -Path to Your Userlog
  57. Macintosh HD1:SSBBS:Special Msgs:Bdays!         -Where to Save Birthday Msg Output
  58. Macintosh HD1:SSBBS:Gliders                     -App to Launch When Done
  59. [0;1;34;47mThe Final Nexus [0;30;47m            -Your BBS Name (ANSI Optional)
  60. 6                                               -Header/Time/Date Color
  61. 1                                               -ANSI Boarder Color
  62. 5                                               -Color of Names/Dates
  63. 2                                               -Color of Today's Birthday Names
  64. 8                                               -ANSI Background Color
  65. 1                                               -1=Output file has a clear screen
  66.                                                  0=Output file has no clear screen
  67. 0                                               -Used for Registration.  If you have
  68.                                                  not registered, leave as a 0.
  69.  
  70. ANSI Color Table for Above Variables
  71. 1 = Black
  72. 2 = Red
  73. 3 = Green
  74. 4 = Yellow
  75. 5 = Blue
  76. 6 = Magenta
  77. 7 = Cyan
  78. 8 = White
  79.  
  80. When To Use It:
  81.  
  82. Since everyone’s BBS is different, it is hard to say when to use UserGrabber.  If you are using a netmail application, then you might as well run UserGrabber at the same time as part of your nightly mail activities.  If your BBS runs some sort of maintenance utility that resets the Userlog (purges the inactive users) on a nightly basis, then you would want to have BirthdayGrabber in the launch chain after your Userlog is updated.  If BirthdayGrabber is not your only timed utility, make sure that the next utility that you want to launch is the one specified in the “App to Launch When Done” string in the data file.
  83.  
  84. Note From The Author:
  85.  
  86. Thank you for taking the time to look at this, I hope it is a fine addition to your Bulletin Board System.  It has taken me hours and hours of work to get it just right, so if you like it please send me just $5 to the address below.  I’ll then keep you and your BBS on my list so you are the first to get the next version and any updates I may have for you.  Also you may send any bug reports to my contact information.  Most importantly it keeps me writing external applications for Second Sight and ensures that any comments or suggestions you have for BirthdayGrabber or any application ideas gets top priority with me.
  87.  
  88. Sincerely,
  89.  
  90.  
  91.  
  92.  
  93.  
  94.  
  95.  
  96. Steve Major
  97.  
  98. Contact Information:
  99.  
  100. Steven Major
  101. P.O. Box 562
  102. Champlain, NY 12919
  103.  
  104. The Final Nexus BBS: 518-561-3002
  105. AOL: Steve Majo
  106. eWorld: Steve Major
  107. Internet: stevemajo@aol.com
  108.  
  109. Version History:
  110.  
  111. 1.0.0 - Initial Release.
  112.  
  113. Register UserGrabber:
  114.  
  115. If you are using BirthdayGrabber, please register it.  By registering BirthdayGrabber, you will get a registration code that will enable you to turn off the splash-ad for my BBS in the text file as well as the ANSI line above it.
  116.  
  117. Distribution:
  118.  
  119. BirthdayGrabber maybe freely uploaded to any Bulletin Board or On-Line service.  Shareware vendors may include UserGrabber in any or all of their Shareware bundles, providing that I am notified by E-Mail or In Writing of the plans to include BirthdayGrabber.
  120.  
  121. System Requirements:
  122.  
  123. BirthdayGrabber will operate on any Macintosh with System 7.x and 768K available.  BirthdayGrabber will only work with Second Sight 3.5 or above.
  124.